Changelog: generalize vendor references, wording fixes and formatting cleanup - #555

Walkthrough

This PR revises changelog wording across historical entries in CHANGELOG.md and CHANGELOG_FULL.md, including vendor-neutral phrasing, clarified descriptions, and updated summary totals. No code logic or public API declarations changed.

Changes

Changelog wording revisions

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested labels: documentation

• X
• Mastodon
• Reddit
• LinkedIn

• Generalize vendor/framework references across changelog history for neutrality.
• Fix a few entry titles/descriptions to improve phrasing consistency.
• Clean up line-wrapping/whitespace to keep CHANGELOG variants aligned.

graph TD
  A([Docs author]) --> B["CHANGELOG.md"] --> D([Readers / release notes])
  A([Docs author]) --> C["CHANGELOG_FULL.md"] --> D([Readers / release notes])

Loading

The following are alternative approaches to this PR:

1. Add a CI check for prohibited vendor terms

• ➕ Prevents regressions (new vendor mentions) automatically
• ➕ Keeps changelog language consistent without repeated manual sweeps
• ➖ Requires agreeing on the denylist/allowlist and maintaining it
• ➖ May need exceptions for legitimate historical context

2. Centralize wording guidance (glossary/style note) and link it

• ➕ Low effort ongoing; documents the desired neutral terminology
• ➕ Helps future contributors choose consistent phrasing
• ➖ Does not enforce compliance; relies on reviewer diligence
• ➖ Still allows drift if not referenced

Recommendation: The PR’s approach (direct edits in both changelog files) is appropriate for a one-time cleanup and keeps history intact. Consider a lightweight follow-up CI/lint rule (or a documented style note) to prevent reintroducing vendor-specific naming going forward.

Documentation (2) +61 / -61

CHANGELOG.mdVendor-neutral changelog wording + minor formatting fixes +28/-28

Vendor-neutral changelog wording + minor formatting fixes

• Replaces vendor/framework-specific phrasing with more generic wording in several historical entries (e.g., configurator DX and audit references). Also fixes minor line-wrapping/whitespace issues to improve readability without changing the version history.

CHANGELOG.md

CHANGELOG_FULL.mdMirror vendor-neutral wording and whitespace cleanup from main changelog +33/-33

Mirror vendor-neutral wording and whitespace cleanup from main changelog

• Applies the same vendor-neutral language updates and small formatting/whitespace fixes as CHANGELOG.md to keep the full history consistent. Adjusts a few entry titles/descriptions while preserving the underlying changelog structure and semantics.

CHANGELOG_FULL.md

Description

Changelog entries for PR #47 and PR #135 are truncated mid-word ("overla" and "replacin") in both
CHANGELOG.md and CHANGELOG_FULL.md, leaving incomplete rendered summaries. This appears to be
accidental truncation rather than intentional formatting.

Code

CHANGELOG_FULL.md[R26-27]

+- **#47** — completion checklist — framework coverage benchmark
+  > Comprehensive completion checklist for bringing the existing SLASHED layers to 100% — benchmarked against a comparable utility-class feature set (closest match, ~85% overla

Relevance

⭐⭐⭐ High

Team frequently edits CHANGELOG for accuracy/cleanup (PRs #414, #268/#269); truncated text likely
fixed.

PR-#414
PR-#269
PR-#268

ⓘ Recommendations generated based on similar findings in past PRs

Evidence

In both CHANGELOG.md and CHANGELOG_FULL.md, the PR #47 blockquote summary line ends with "~85%
overla" and the next changelog entry (#48) begins immediately on the following line, showing the
sentence does not continue anywhere else. Likewise, the PR #135 blockquote summary line ends with
"replacin" and the next entry (#136) starts immediately after, confirming the text was cut off in
the final markdown output rather than wrapped or continued.

CHANGELOG.md[971-976]
CHANGELOG_FULL.md[24-28]
CHANGELOG.md[887-890]
CHANGELOG_FULL.md[172-177]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The changelog blockquote summaries for PR #47 and PR #135 are cut off mid-word ("overla" and "replacin") in both the short and full changelog files, resulting in incomplete sentences in the rendered changelog.

## Issue Context
This truncation appears in both CHANGELOG.md and CHANGELOG_FULL.md; the surrounding entries start immediately on the next line (#48 after #47, and #136 after #135), indicating the missing text is not continued elsewhere. These sections were impacted by PR wording/title/description edits, but the final blockquote summaries remain truncated.

## Fix Focus Areas
- CHANGELOG.md[973-975]
- CHANGELOG_FULL.md[26-28]
- CHANGELOG.md[887-889]
- CHANGELOG_FULL.md[174-176]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools